isbinaryfile

What is isbinaryfile?

The isbinaryfile npm package is used to determine if a file is binary or text. This can be useful in various scenarios such as file processing, content analysis, and data validation.

What are isbinaryfile's main functionalities?

Check if a file is binary by file path

This feature allows you to check if a file is binary by providing the file path. The function returns a promise that resolves to a boolean indicating whether the file is binary.

const { isBinaryFile } = require('isbinaryfile');

(async () => {
  const result = await isBinaryFile('path/to/file');
  console.log(result); // true or false
})();

Check if a file is binary by buffer

This feature allows you to check if a file is binary by providing a buffer. The function returns a promise that resolves to a boolean indicating whether the file is binary.

const { isBinaryFile } = require('isbinaryfile');
const fs = require('fs');

(async () => {
  const buffer = fs.readFileSync('path/to/file');
  const result = await isBinaryFile(buffer);
  console.log(result); // true or false
})();

Other packages similar to isbinaryfile

isbinaryfile

The isbinaryfile package is another option for determining if a file is binary or text. It offers similar functionality to the isbinaryfile package, allowing you to check files by path or buffer.

file-type

The file-type package can detect the file type of a buffer or stream. While it is more focused on identifying the file type rather than just determining if it is binary, it can be used to achieve similar results by checking the detected file type.

binaryextensions

The binaryextensions package provides a list of binary file extensions. While it does not directly check if a file is binary, it can be used in conjunction with file extension checks to determine if a file is likely to be binary.

README

isBinaryFile

Detects if a file is binary in Node.js. Similar to Perl's -B switch, in that:

• it reads the first few thousand bytes of a file
• checks for a null byte; if it's found, it's binary
• flags non-ASCII characters. After a certain number of "weird" characters, the file is flagged as binary

Much of the logic is pretty much ported from ag.

Note: if the file doesn't exist, is a directory, or is empty, the function returns false.

Installation

npm install isbinaryfile

Usage

isBinaryFile(filepath, callback)

• filepath, a string indicating the path to the file.
• callback, a function for the callback. It has two arguments:
  • err, the typical Node.js error argument
  • result, a boolean of true or false, depending on if the file is binary

isBinaryFile(bytes, size, callback)

• bytes, a Buffer of the file's contents.
• size, an optional number indicating the file size.
• callback, a function for the callback. It has two arguments:
  • err, the typical Node.js error argument
  • result, a boolean of true or false, depending on if the file is binary

isBinaryFile.sync(filepath)

• filepath, a string indicating the path to the file.

isBinaryFile.sync(bytes, size)

• bytes, a Buffer of the file's contents.
• size, an number indicating the file size.

Returns a boolean of true or false, depending on if the file is binary.

Examples

var isBinaryFile = require("isbinaryfile");

fs.readFile("some_file", function(err, data) {
  fs.lstat("some_file", function(err, stat) {
    isBinaryFile(data, stat.size, function (err, result) {
      if (!err) {
        if (result) {
          console.log("It is!")
        }
        else {
          console.log("No.")
        }
      }
    });
  });
});

isBinaryFile.sync("some_file"); // true or false
var bytes = fs.readFileSync(("some_file"));
var size = fs.lstatSync(("some_file").size;
isBinaryFile.sync(bytes, size); // true or false

Testing

Run npm install to install mocha, then run npm test.